﻿#region Header
// ------------------------ Licence / Copyright ------------------------
// 
// ScrumTable for Scrum Meeting Support
// Copyright © HSR - Hochschule für Technik Rapperswil
// All Rights Reserved
// 
// Author:
//  Michael Gfeller Silvan Gehrig Patrick Boos
// 
// ---------------------------------------------------------------------
#endregion

#region Usings

using System;
using System.Collections.Generic;
using ScrumTable.DL.Data.Schema;

#endregion

namespace ScrumTable.DL.Data.Common.Serialization
{
    /// <summary>
    /// Resolves an data on server side to data on the local machine.
    /// </summary>
    public interface IDataResolver
    {
        #region Properties
        //--------------------------------------------------------------------
        // Properties
        //--------------------------------------------------------------------

        #endregion

        #region Methods
        //--------------------------------------------------------------------
        // Methods
        //--------------------------------------------------------------------

        /// <summary>
        /// Saves the specified uri to download into the given directory and
        /// returns the new relative url on the local storage.
        /// </summary>
        /// <param name="recommendedPath">Specifies the file and directory where local data can be stored.</param>
        /// <param name="toDownload">Specifies the url to resolve.</param>
        /// <returns>Returns an url which points to the data on the local storage.</returns>
        Uri ResolveTo(string recommendedPath, Uri toDownload);

        #endregion

        #region Events
        //--------------------------------------------------------------------
        // Events
        //--------------------------------------------------------------------

        #endregion
    }
}